home *** CD-ROM | disk | FTP | other *** search
/ NeXTSTEP 3.3 (Developer)…68k, x86, SPARC, PA-RISC] / NeXTSTEP 3.3 Dev Intel.iso / NextDeveloper / Source / GNU / cc / gcc.info-9 (.txt) < prev    next >
GNU Info File  |  1993-10-21  |  40KB  |  690 lines

  1. This is Info file gcc.info, produced by Makeinfo-1.54 from the input
  2. file gcc.texi.
  3.    This file documents the use and the internals of the GNU compiler.
  4.    Published by the Free Software Foundation 675 Massachusetts Avenue
  5. Cambridge, MA 02139 USA
  6.    Copyright (C) 1988, 1989, 1992, 1993 Free Software Foundation, Inc.
  7.    Permission is granted to make and distribute verbatim copies of this
  8. manual provided the copyright notice and this permission notice are
  9. preserved on all copies.
  10.    Permission is granted to copy and distribute modified versions of
  11. this manual under the conditions for verbatim copying, provided also
  12. that the sections entitled "GNU General Public License" and "Protect
  13. Your Freedom--Fight `Look And Feel'" are included exactly as in the
  14. original, and provided that the entire resulting derived work is
  15. distributed under the terms of a permission notice identical to this
  16.    Permission is granted to copy and distribute translations of this
  17. manual into another language, under the above conditions for modified
  18. versions, except that the sections entitled "GNU General Public
  19. License" and "Protect Your Freedom--Fight `Look And Feel'", and this
  20. permission notice, may be included in translations approved by the Free
  21. Software Foundation instead of in the original English.
  22. File: gcc.info,  Node: Incompatibilities,  Next: Fixed Headers,  Prev: External Bugs,  Up: Trouble
  23. Incompatibilities of GNU CC
  24. ===========================
  25.    There are several noteworthy incompatibilities between GNU C and most
  26. existing (non-ANSI) versions of C.  The `-traditional' option
  27. eliminates many of these incompatibilities, *but not all*, by telling
  28. GNU C to behave like the other C compilers.
  29.    * GNU CC normally makes string constants read-only.  If several
  30.      identical-looking string constants are used, GNU CC stores only one
  31.      copy of the string.
  32.      One consequence is that you cannot call `mktemp' with a string
  33.      constant argument.  The function `mktemp' always alters the string
  34.      its argument points to.
  35.      Another consequence is that `sscanf' does not work on some systems
  36.      when passed a string constant as its format control string or
  37.      input.  This is because `sscanf' incorrectly tries to write into
  38.      the string constant.  Likewise `fscanf' and `scanf'.
  39.      The best solution to these problems is to change the program to use
  40.      `char'-array variables with initialization strings for these
  41.      purposes instead of string constants.  But if this is not possible,
  42.      you can use the `-fwritable-strings' flag, which directs GNU CC to
  43.      handle string constants the same way most C compilers do.
  44.      `-traditional' also has this effect, among others.
  45.    * `-2147483648' is positive.
  46.      This is because 2147483648 cannot fit in the type `int', so
  47.      (following the ANSI C rules) its data type is `unsigned long int'.
  48.      Negating this value yields 2147483648 again.
  49.    * GNU CC does not substitute macro arguments when they appear inside
  50.      of string constants.  For example, the following macro in GNU CC
  51.           #define foo(a) "a"
  52.      will produce output `"a"' regardless of what the argument A is.
  53.      The `-traditional' option directs GNU CC to handle such cases
  54.      (among others) in the old-fashioned (non-ANSI) fashion.
  55.    * When you use `setjmp' and `longjmp', the only automatic variables
  56.      guaranteed to remain valid are those declared `volatile'.  This is
  57.      a consequence of automatic register allocation.  Consider this
  58.      function:
  59.           jmp_buf j;
  60.           
  61.           foo ()
  62.           {
  63.             int a, b;
  64.           
  65.             a = fun1 ();
  66.             if (setjmp (j))
  67.               return a;
  68.           
  69.             a = fun2 ();
  70.             /* `longjmp (j)' may occur in `fun3'. */
  71.             return a + fun3 ();
  72.           }
  73.      Here `a' may or may not be restored to its first value when the
  74.      `longjmp' occurs.  If `a' is allocated in a register, then its
  75.      first value is restored; otherwise, it keeps the last value stored
  76.      in it.
  77.      If you use the `-W' option with the `-O' option, you will get a
  78.      warning when GNU CC thinks such a problem might be possible.
  79.      The `-traditional' option directs GNU C to put variables in the
  80.      stack by default, rather than in registers, in functions that call
  81.      `setjmp'.  This results in the behavior found in traditional C
  82.      compilers.
  83.    * Programs that use preprocessor directives in the middle of macro
  84.      arguments do not work with GNU CC.  For example, a program like
  85.      this will not work:
  86.           foobar (
  87.           #define luser
  88.                   hack)
  89.      ANSI C does not permit such a construct.  It would make sense to
  90.      support it when `-traditional' is used, but it is too much work to
  91.      implement.
  92.    * Declarations of external variables and functions within a block
  93.      apply only to the block containing the declaration.  In other
  94.      words, they have the same scope as any other declaration in the
  95.      same place.
  96.      In some other C compilers, a `extern' declaration affects all the
  97.      rest of the file even if it happens within a block.
  98.      The `-traditional' option directs GNU C to treat all `extern'
  99.      declarations as global, like traditional compilers.
  100.    * In traditional C, you can combine `long', etc., with a typedef
  101.      name, as shown here:
  102.           typedef int foo;
  103.           typedef long foo bar;
  104.      In ANSI C, this is not allowed: `long' and other type modifiers
  105.      require an explicit `int'.  Because this criterion is expressed by
  106.      Bison grammar rules rather than C code, the `-traditional' flag
  107.      cannot alter it.
  108.    * PCC allows typedef names to be used as function parameters.  The
  109.      difficulty described immediately above applies here too.
  110.    * PCC allows whitespace in the middle of compound assignment
  111.      operators such as `+='.  GNU CC, following the ANSI standard, does
  112.      not allow this.  The difficulty described immediately above
  113.      applies here too.
  114.    * GNU CC complains about unterminated character constants inside of
  115.      preprocessor conditionals that fail.  Some programs have English
  116.      comments enclosed in conditionals that are guaranteed to fail; if
  117.      these comments contain apostrophes, GNU CC will probably report an
  118.      error.  For example, this code would produce an error:
  119.           #if 0
  120.           You can't expect this to work.
  121.           #endif
  122.      The best solution to such a problem is to put the text into an
  123.      actual C comment delimited by `/*...*/'.  However, `-traditional'
  124.      suppresses these error messages.
  125.    * Many user programs contain the declaration `long time ();'.  In the
  126.      past, the system header files on many systems did not actually
  127.      declare `time', so it did not matter what type your program
  128.      declared it to return.  But in systems with ANSI C headers, `time'
  129.      is declared to return `time_t', and if that is not the same as
  130.      `long', then `long time ();' is erroneous.
  131.      The solution is to change your program to use `time_t' as the
  132.      return type of `time'.
  133.    * When compiling functions that return `float', PCC converts it to a
  134.      double.  GNU CC actually returns a `float'.  If you are concerned
  135.      with PCC compatibility, you should declare your functions to return
  136.      `double'; you might as well say what you mean.
  137.    * When compiling functions that return structures or unions, GNU CC
  138.      output code normally uses a method different from that used on most
  139.      versions of Unix.  As a result, code compiled with GNU CC cannot
  140.      call a structure-returning function compiled with PCC, and vice
  141.      versa.
  142.      The method used by GNU CC is as follows: a structure or union
  143.      which is 1, 2, 4 or 8 bytes long is returned like a scalar.  A
  144.      structure or union with any other size is stored into an address
  145.      supplied by the caller (usually in a special, fixed register, but
  146.      on some machines it is passed on the stack).  The
  147.      machine-description macros `STRUCT_VALUE' and
  148.      `STRUCT_INCOMING_VALUE' tell GNU CC where to pass this address.
  149.      By contrast, PCC on most target machines returns structures and
  150.      unions of any size by copying the data into an area of static
  151.      storage, and then returning the address of that storage as if it
  152.      were a pointer value.  The caller must copy the data from that
  153.      memory area to the place where the value is wanted.  GNU CC does
  154.      not use this method because it is slower and nonreentrant.
  155.      On some newer machines, PCC uses a reentrant convention for all
  156.      structure and union returning.  GNU CC on most of these machines
  157.      uses a compatible convention when returning structures and unions
  158.      in memory, but still returns small structures and unions in
  159.      registers.
  160.      You can tell GNU CC to use a compatible convention for all
  161.      structure and union returning with the option
  162.      `-fpcc-struct-return'.
  163.    * GNU C complains about program fragments such as `0x74ae-0x4000'
  164.      which appear to be two hexadecimal constants separated by the minus
  165.      operator.  Actually, this string is a single "preprocessing token".
  166.      Each such token must correspond to one token in C.  Since this
  167.      does not, GNU C prints an error message.  Although it may appear
  168.      obvious that what is meant is an operator and two values, the ANSI
  169.      C standard specifically requires that this be treated as erroneous.
  170.      A "preprocessing token" is a "preprocessing number" if it begins
  171.      with a digit and is followed by letters, underscores, digits,
  172.      periods and `e+', `e-', `E+', or `E-' character sequences.
  173.      To make the above program fragment valid, place whitespace in
  174.      front of the minus sign.  This whitespace will end the
  175.      preprocessing number.
  176. File: gcc.info,  Node: Fixed Headers,  Next: Disappointments,  Prev: Incompatibilities,  Up: Trouble
  177. Fixed Header Files
  178. ==================
  179.    GNU CC needs to install corrected versions of some system header
  180. files.  This is because most target systems have some header files that
  181. won't work with GNU CC unless they are changed.  Some have bugs, some
  182. are incompatible with ANSI C, and some depend on special features of
  183. other compilers.
  184.    Installing GNU CC automatically creates and installs the fixed header
  185. files, by running a program called `fixincludes' (or for certain
  186. targets an alternative such as `fixinc.svr4').  Normally, you don't
  187. need to pay attention to this.  But there are cases where it doesn't do
  188. the right thing automatically.
  189.    * If you update the system's header files, such as by installing a
  190.      new system version, the fixed header files of GNU CC are not
  191.      automatically updated.  The easiest way to update them is to
  192.      reinstall GNU CC.  (If you want to be clever, look in the makefile
  193.      and you can find a shortcut.)
  194.    * On some systems, in particular SunOS 4, header file directories
  195.      contain machine-specific symbolic links in certain places.  This
  196.      makes it possible to share most of the header files among hosts
  197.      running the same version of SunOS 4 on different machine models.
  198.      The programs that fix the header files do not understand this
  199.      special way of using symbolic links; therefore, the directory of
  200.      fixed header files is good only for the machine model used to
  201.      build it.
  202.      In SunOS 4, only programs that look inside the kernel will notice
  203.      the difference between machine models.  Therefore, for most
  204.      purposes, you need not be concerned about this.
  205.      It is possible to make separate sets of fixed header files for the
  206.      different machine models, and arrange a structure of symbolic
  207.      links so as to use the proper set, but you'll have to do this by
  208.      hand.
  209. File: gcc.info,  Node: Disappointments,  Next: C++ Misunderstandings,  Prev: Fixed Headers,  Up: Trouble
  210. Disappointments and Misunderstandings
  211. =====================================
  212.    These problems are perhaps regrettable, but we don't know any
  213. practical way around them.
  214.    * Certain local variables aren't recognized by debuggers when you
  215.      compile with optimization.
  216.      This occurs because sometimes GNU CC optimizes the variable out of
  217.      existence.  There is no way to tell the debugger how to compute the
  218.      value such a variable "would have had", and it is not clear that
  219.      would be desirable anyway.  So GNU CC simply does not mention the
  220.      eliminated variable when it writes debugging information.
  221.      You have to expect a certain amount of disagreement between the
  222.      executable and your source code, when you use optimization.
  223.    * Users often think it is a bug when GNU CC reports an error for code
  224.      like this:
  225.           int foo (struct mumble *);
  226.           
  227.           struct mumble { ... };
  228.           
  229.           int foo (struct mumble *x)
  230.           { ... }
  231.      This code really is erroneous, because the scope of `struct
  232.      mumble' in the prototype is limited to the argument list
  233.      containing it.  It does not refer to the `struct mumble' defined
  234.      with file scope immediately below--they are two unrelated types
  235.      with similar names in different scopes.
  236.      But in the definition of `foo', the file-scope type is used
  237.      because that is available to be inherited.  Thus, the definition
  238.      and the prototype do not match, and you get an error.
  239.      This behavior may seem silly, but it's what the ANSI standard
  240.      specifies.  It is easy enough for you to make your code work by
  241.      moving the definition of `struct mumble' above the prototype.
  242.      It's not worth being incompatible with ANSI C just to avoid an
  243.      error for the example shown above.
  244.    * Accesses to bitfields even in volatile objects works by accessing
  245.      larger objects, such as a byte or a word.  You cannot rely on what
  246.      size of object is accessed in order to read or write the bitfield;
  247.      it may even vary for a given bitfield according to the precise
  248.      usage.
  249.      If you care about controlling the amount of memory that is
  250.      accessed, use volatile but do not use bitfields.
  251.    * GNU CC comes with shell scripts to fix certain known problems in
  252.      system header files.  They install corrected copies of various
  253.      header files in a special directory where only GNU CC will
  254.      normally look for them.  The scripts adapt to various systems by
  255.      searching all the system header files for the problem cases that
  256.      we know about.
  257.      If new system header files are installed, nothing automatically
  258.      arranges to update the corrected header files.  You will have to
  259.      reinstall GNU CC to fix the new header files.  More specifically,
  260.      go to the build directory and delete the files `stmp-fixinc' and
  261.      `stmp-headers', and the subdirectory `include'; then do `make
  262.      install' again.
  263.    * On 68000 systems, you can get paradoxical results if you test the
  264.      precise values of floating point numbers.  For example, you can
  265.      find that a floating point value which is not a NaN is not equal
  266.      to itself.  This results from the fact that the the floating point
  267.      registers hold a few more bits of precision than fit in a `double'
  268.      in memory.  Compiled code moves values between memory and floating
  269.      point registers at its convenience, and moving them into memory
  270.      truncates them.
  271.      You can partially avoid this problem by using the `-ffloat-store'
  272.      option (*note Optimize Options::.).
  273.    * On the MIPS, variable argument functions using `varargs.h' cannot
  274.      have a floating point value for the first argument.  The reason
  275.      for this is that in the absence of a prototype in scope, if the
  276.      first argument is a floating point, it is passed in a floating
  277.      point register, rather than an integer register.
  278.      If the code is rewritten to use the ANSI standard `stdarg.h'
  279.      method of variable arguments, and the prototype is in scope at the
  280.      time of the call, everything will work fine.
  281. File: gcc.info,  Node: C++ Misunderstandings,  Next: Protoize Caveats,  Prev: Disappointments,  Up: Trouble
  282. Common Misunderstandings with GNU C++
  283. =====================================
  284.    C++ is a complex language and an evolving one, and its standard
  285. definition (the ANSI C++ draft standard) is also evolving.  As a result,
  286. your C++ compiler may occasionally surprise you, even when its behavior
  287. is correct.  This section discusses some areas that frequently give
  288. rise to questions of this sort.
  289. * Menu:
  290. * Static Definitions::  Static member declarations are not definitions
  291. * Temporaries::         Temporaries may vanish before you expect
  292. File: gcc.info,  Node: Static Definitions,  Next: Temporaries,  Up: C++ Misunderstandings
  293. Declare *and* Define Static Members
  294. -----------------------------------
  295.    When a class has static data members, it is not enough to *declare*
  296. the static member; you must also *define* it.  For example:
  297.      class Foo
  298.      {
  299.        ...
  300.        void method();
  301.        static int bar;
  302.      };
  303.    This declaration only establishes that the class `Foo' has an `int'
  304. named `Foo::bar', and a member function named `Foo::method'.  But you
  305. still need to define *both* `method' and `bar' elsewhere.  According to
  306. the draft ANSI standard, you must supply an initializer in one (and
  307. only one) source file, such as:
  308.      int Foo::bar = 0;
  309.    Other C++ compilers may not correctly implement the standard
  310. behavior.  As a result, when you switch to `g++' from one of these
  311. compilers, you may discover that a program that appeared to work
  312. correctly in fact does not conform to the standard: `g++' reports as
  313. undefined symbols any static data members that lack definitions.
  314. File: gcc.info,  Node: Temporaries,  Prev: Static Definitions,  Up: C++ Misunderstandings
  315. Temporaries May Vanish Before You Expect
  316. ----------------------------------------
  317.    It is dangerous to use pointers or references to *portions* of a
  318. temporary object.  The compiler may very well delete the object before
  319. you expect it to, leaving a pointer to garbage.  The most common place
  320. where this problem crops up is in classes like the libg++ `String'
  321. class, that define a conversion function to type `char *' or `const
  322. char *'.  However, any class that returns a pointer to some internal
  323. structure is potentially subject to this problem.
  324.    For example, a program may use a function `strfunc' that returns
  325. `String' objects, and another function `charfunc' that operates on
  326. pointers to `char':
  327.      String strfunc ();
  328.      void charfunc (const char *);
  329. In this situation, it may seem natural to write
  330. `charfunc (strfunc ());' based on the knowledge that class `String' has
  331. an explicit conversion to `char' pointers.  However, what really
  332. happens is akin to `charfunc (strfunc ().convert ());', where the
  333. `convert' method is a function to do the same data conversion normally
  334. performed by a cast.  Since the last use of the temporary `String'
  335. object is the call to the conversion function, the compiler may delete
  336. that object before actually calling `charfunc'.  The compiler has no
  337. way of knowing that deleting the `String' object will invalidate the
  338. pointer.  The pointer then points to garbage, so that by the time
  339. `charfunc' is called, it gets an invalid argument.
  340.    Code like this may run successfully under some other compilers,
  341. especially those that delete temporaries relatively late.  However, the
  342. GNU C++ behavior is also standard-conformant, so if your program depends
  343. on late destruction of temporaries it is not portable.
  344.    If you think this is surprising, you should be aware that the ANSI
  345. C++ committee continues to debate the lifetime-of-temporaries problem.
  346.    For now, at least, the safe way to write such code is to give the
  347. temporary a name, which forces it to remain until the end of the scope
  348. of the name.  For example:
  349.      String& tmp = strfunc ();
  350.      charfunc (tmp);
  351. File: gcc.info,  Node: Protoize Caveats,  Next: Non-bugs,  Prev: C++ Misunderstandings,  Up: Trouble
  352. Caveats of using `protoize'
  353. ===========================
  354.    The conversion programs `protoize' and `unprotoize' can sometimes
  355. change a source file in a way that won't work unless you rearrange it.
  356.    * `protoize' can insert references to a type name or type tag before
  357.      the definition, or in a file where they are not defined.
  358.      If this happens, compiler error messages should show you where the
  359.      new references are, so fixing the file by hand is straightforward.
  360.    * There are some C constructs which `protoize' cannot figure out.
  361.      For example, it can't determine argument types for declaring a
  362.      pointer-to-function variable; this you must do by hand.  `protoize'
  363.      inserts a comment containing `???' each time it finds such a
  364.      variable; so you can find all such variables by searching for this
  365.      string.  ANSI C does not require declaring the argument types of
  366.      pointer-to-function types.
  367.    * Using `unprotoize' can easily introduce bugs.  If the program
  368.      relied on prototypes to bring about conversion of arguments, these
  369.      conversions will not take place in the program without prototypes.
  370.      One case in which you can be sure `unprotoize' is safe is when you
  371.      are removing prototypes that were made with `protoize'; if the
  372.      program worked before without any prototypes, it will work again
  373.      without them.
  374.      You can find all the places where this problem might occur by
  375.      compiling the program with the `-Wconversion' option.  It prints a
  376.      warning whenever an argument is converted.
  377.    * Both conversion programs can be confused if there are macro calls
  378.      in and around the text to be converted.  In other words, the
  379.      standard syntax for a declaration or definition must not result
  380.      from expanding a macro.  This problem is inherent in the design of
  381.      C and cannot be fixed.  If only a few functions have confusing
  382.      macro calls, you can easily convert them manually.
  383.    * `protoize' cannot get the argument types for a function whose
  384.      definition was not actually compiled due to preprocessor
  385.      conditionals.  When this happens, `protoize' changes nothing in
  386.      regard to such a function.  `protoize' tries to detect such
  387.      instances and warn about them.
  388.      You can generally work around this problem by using `protoize' step
  389.      by step, each time specifying a different set of `-D' options for
  390.      compilation, until all of the functions have been converted.
  391.      There is no automatic way to verify that you have got them all,
  392.      however.
  393.    * Confusion may result if there is an occasion to convert a function
  394.      declaration or definition in a region of source code where there
  395.      is more than one formal parameter list present.  Thus, attempts to
  396.      convert code containing multiple (conditionally compiled) versions
  397.      of a single function header (in the same vicinity) may not produce
  398.      the desired (or expected) results.
  399.      If you plan on converting source files which contain such code, it
  400.      is recommended that you first make sure that each conditionally
  401.      compiled region of source code which contains an alternative
  402.      function header also contains at least one additional follower
  403.      token (past the final right parenthesis of the function header).
  404.      This should circumvent the problem.
  405.    * `unprotoize' can become confused when trying to convert a function
  406.      definition or declaration which contains a declaration for a
  407.      pointer-to-function formal argument which has the same name as the
  408.      function being defined or declared.  We recommand you avoid such
  409.      choices of formal parameter names.
  410.    * You might also want to correct some of the indentation by hand and
  411.      break long lines.  (The conversion programs don't write lines
  412.      longer than eighty characters in any case.)
  413. File: gcc.info,  Node: Non-bugs,  Next: Warnings and Errors,  Prev: Protoize Caveats,  Up: Trouble
  414. Certain Changes We Don't Want to Make
  415. =====================================
  416.    This section lists changes that people frequently request, but which
  417. we do not make because we think GNU CC is better without them.
  418.    * Checking the number and type of arguments to a function which has
  419.      an old-fashioned definition and no prototype.
  420.      Such a feature would work only occasionally--only for calls that
  421.      appear in the same file as the called function, following the
  422.      definition.  The only way to check all calls reliably is to add a
  423.      prototype for the function.  But adding a prototype eliminates the
  424.      motivation for this feature.  So the feature is not worthwhile.
  425.    * Warning about using an expression whose type is signed as a shift
  426.      count.
  427.      Shift count operands are probably signed more often than unsigned.
  428.      Warning about this would cause far more annoyance than good.
  429.    * Warning about assigning a signed value to an unsigned variable.
  430.      Such assignments must be very common; warning about them would
  431.      cause more annoyance than good.
  432.    * Warning about unreachable code.
  433.      It's very common to have unreachable code in machine-generated
  434.      programs.  For example, this happens normally in some files of GNU
  435.      C itself.
  436.    * Warning when a non-void function value is ignored.
  437.      Coming as I do from a Lisp background, I balk at the idea that
  438.      there is something dangerous about discarding a value.  There are
  439.      functions that return values which some callers may find useful;
  440.      it makes no sense to clutter the program with a cast to `void'
  441.      whenever the value isn't useful.
  442.    * Assuming (for optimization) that the address of an external symbol
  443.      is never zero.
  444.      This assumption is false on certain systems when `#pragma weak' is
  445.      used.
  446.    * Making `-fshort-enums' the default.
  447.      This would cause storage layout to be incompatible with most other
  448.      C compilers.  And it doesn't seem very important, given that you
  449.      can get the same result in other ways.  The case where it matters
  450.      most is when the enumeration-valued object is inside a structure,
  451.      and in that case you can specify a field width explicitly.
  452.    * Making bitfields unsigned by default on particular machines where
  453.      "the ABI standard" says to do so.
  454.      The ANSI C standard leaves it up to the implementation whether a
  455.      bitfield declared plain `int' is signed or not.  This in effect
  456.      creates two alternative dialects of C.
  457.      The GNU C compiler supports both dialects; you can specify the
  458.      signed dialect with `-fsigned-bitfields' and the unsigned dialect
  459.      with `-funsigned-bitfields'.  However, this leaves open the
  460.      question of which dialect to use by default.
  461.      Currently, the preferred dialect makes plain bitfields signed,
  462.      because this is simplest.  Since `int' is the same as `signed int'
  463.      in every other context, it is cleanest for them to be the same in
  464.      bitfields as well.
  465.      Some computer manufacturers have published Application Binary
  466.      Interface standards which specify that plain bitfields should be
  467.      unsigned.  It is a mistake, however, to say anything about this
  468.      issue in an ABI.  This is because the handling of plain bitfields
  469.      distinguishes two dialects of C.  Both dialects are meaningful on
  470.      every type of machine.  Whether a particular object file was
  471.      compiled using signed bitfields or unsigned is of no concern to
  472.      other object files, even if they access the same bitfields in the
  473.      same data structures.
  474.      A given program is written in one or the other of these two
  475.      dialects.  The program stands a chance to work on most any machine
  476.      if it is compiled with the proper dialect.  It is unlikely to work
  477.      at all if compiled with the wrong dialect.
  478.      Many users appreciate the GNU C compiler because it provides an
  479.      environment that is uniform across machines.  These users would be
  480.      inconvenienced if the compiler treated plain bitfields differently
  481.      on certain machines.
  482.      Occasionally users write programs intended only for a particular
  483.      machine type.  On these occasions, the users would benefit if the
  484.      GNU C compiler were to support by default the same dialect as the
  485.      other compilers on that machine.  But such applications are rare.
  486.      And users writing a program to run on more than one type of
  487.      machine cannot possibly benefit from this kind of compatibility.
  488.      This is why GNU CC does and will treat plain bitfields in the same
  489.      fashion on all types of machines (by default).
  490.      There are some arguments for making bitfields unsigned by default
  491.      on all machines.  If, for example, this becomes a universal de
  492.      facto standard, it would make sense for GNU CC to go along with
  493.      it.  This is something to be considered in the future.
  494.      (Of course, users strongly concerned about portability should
  495.      indicate explicitly in each bitfield whether it is signed or not.
  496.      In this way, they write programs which have the same meaning in
  497.      both C dialects.)
  498.    * Undefining `__STDC__' when `-ansi' is not used.
  499.      Currently, GNU CC defines `__STDC__' as long as you don't use
  500.      `-traditional'.  This provides good results in practice.
  501.      Programmers normally use conditionals on `__STDC__' to ask whether
  502.      it is safe to use certain features of ANSI C, such as function
  503.      prototypes or ANSI token concatenation.  Since plain `gcc' supports
  504.      all the features of ANSI C, the correct answer to these questions
  505.      is "yes".
  506.      Some users try to use `__STDC__' to check for the availability of
  507.      certain library facilities.  This is actually incorrect usage in
  508.      an ANSI C program, because the ANSI C standard says that a
  509.      conforming freestanding implementation should define `__STDC__'
  510.      even though it does not have the library facilities.  `gcc -ansi
  511.      -pedantic' is a conforming freestanding implementation, and it is
  512.      therefore required to define `__STDC__', even though it does not
  513.      come with an ANSI C library.
  514.      Sometimes people say that defining `__STDC__' in a compiler that
  515.      does not completely conform to the ANSI C standard somehow
  516.      violates the standard.  This is illogical.  The standard is a
  517.      standard for compilers that claim to support ANSI C, such as `gcc
  518.      -ansi'--not for other compilers such as plain `gcc'.  Whatever the
  519.      ANSI C standard says is relevant to the design of plain `gcc'
  520.      without `-ansi' only for pragmatic reasons, not as a requirement.
  521.    * Undefining `__STDC__' in C++.
  522.      Programs written to compile with C++-to-C translators get the
  523.      value of `__STDC__' that goes with the C compiler that is
  524.      subsequently used.  These programs must test `__STDC__' to
  525.      determine what kind of C preprocessor that compiler uses: whether
  526.      they should concatenate tokens in the ANSI C fashion or in the
  527.      traditional fashion.
  528.      These programs work properly with GNU C++ if `__STDC__' is defined.
  529.      They would not work otherwise.
  530.      In addition, many header files are written to provide prototypes
  531.      in ANSI C but not in traditional C.  Many of these header files
  532.      can work without change in C++ provided `__STDC__' is defined.  If
  533.      `__STDC__' is not defined, they will all fail, and will all need
  534.      to be changed to test explicitly for C++ as well.
  535.    * Deleting "empty" loops.
  536.      GNU CC does not delete "empty" loops because the most likely reason
  537.      you would put one in a program is to have a delay.  Deleting them
  538.      will not make real programs run any faster, so it would be
  539.      pointless.
  540.      It would be different if optimization of a nonempty loop could
  541.      produce an empty one.  But this generally can't happen.
  542.    * Making side effects happen in the same order as in some other
  543.      compiler.
  544.      It is never safe to depend on the order of evaluation of side
  545.      effects.  For example, a function call like this may very well
  546.      behave differently from one compiler to another:
  547.           void func (int, int);
  548.           
  549.           int i = 2;
  550.           func (i++, i++);
  551.      There is no guarantee (in either the C or the C++ standard language
  552.      definitions) that the increments will be evaluated in any
  553.      particular order.  Either increment might happen first.  `func'
  554.      might get the arguments `3, 4', or it might get `4, 3', or even
  555.      `3, 3'.
  556.    * Using the "canonical" form of the target configuration name as the
  557.      directory for installation.
  558.      This would be an improvement in some respects, but it would also
  559.      cause problems.  For one thing, users might expect to use in the
  560.      `-b' option the same name specified at installation; if
  561.      installation used the canonical form, that would not work.  What's
  562.      more, the canonical name might be too long for certain file
  563.      systems.
  564.      We suggest you make a link to the installation directory under the
  565.      canonical name, if you want to use that name in the `-b' option.
  566. File: gcc.info,  Node: Warnings and Errors,  Prev: Non-bugs,  Up: Trouble
  567. Warning Messages and Error Messages
  568. ===================================
  569.    The GNU compiler can produce two kinds of diagnostics: errors and
  570. warnings.  Each kind has a different purpose:
  571.      *Errors* report problems that make it impossible to compile your
  572.      program.  GNU CC reports errors with the source file name and line
  573.      number where the problem is apparent.
  574.      *Warnings* report other unusual conditions in your code that *may*
  575.      indicate a problem, although compilation can (and does) proceed.
  576.      Warning messages also report the source file name and line number,
  577.      but include the text `warning:' to distinguish them from error
  578.      messages.
  579.    Warnings may indicate danger points where you should check to make
  580. sure that your program really does what you intend; or the use of
  581. obsolete features; or the use of nonstandard features of GNU C or C++.
  582. Many warnings are issued only if you ask for them, with one of the `-W'
  583. options (for instance, `-Wall' requests a variety of useful warnings).
  584.    GNU CC always tries to compile your program if possible; it never
  585. gratuituously rejects a program whose meaning is clear merely because
  586. (for instance) it fails to conform to a standard.  In some cases,
  587. however, the C and C++ standards specify that certain extensions are
  588. forbidden, and a diagnostic *must* be issued by a conforming compiler.
  589. The `-pedantic' option tells GNU CC to issue warnings in such cases;
  590. `-pedantic-errors' says to make them errors instead.  This does not
  591. mean that *all* non-ANSI constructs get warnings or errors.
  592.    *Note Options to Request or Suppress Warnings: Warning Options, for
  593. more detail on these and related command-line options.
  594. File: gcc.info,  Node: Bugs,  Next: Service,  Prev: Trouble,  Up: Top
  595. Reporting Bugs
  596. **************
  597.    Your bug reports play an essential role in making GNU CC reliable.
  598.    When you encounter a problem, the first thing to do is to see if it
  599. is already known.  *Note Trouble::.  If it isn't known, then you should
  600. report the problem.
  601.    Reporting a bug may help you by bringing a solution to your problem,
  602. or it may not.  (If it does not, look in the service directory; see
  603. *Note Service::.)  In any case, the principal function of a bug report
  604. is to help the entire community by making the next version of GNU CC
  605. work better.  Bug reports are your contribution to the maintenance of
  606. GNU CC.
  607.    Since the maintainers are very overloaded, we cannot respond to every
  608. bug report.  However, if the bug has not been fixed, we are likely to
  609. send you a patch and ask you to tell us whether it works.
  610.    In order for a bug report to serve its purpose, you must include the
  611. information that makes for fixing the bug.
  612. * Menu:
  613. * Criteria:  Bug Criteria.   Have you really found a bug?
  614. * Where: Bug Lists.         Where to send your bug report.
  615. * Reporting: Bug Reporting.  How to report a bug effectively.
  616. * Patches: Sending Patches.  How to send a patch for GNU CC.
  617. * Known: Trouble.            Known problems.
  618. * Help: Service.             Where to ask for help.
  619. File: gcc.info,  Node: Bug Criteria,  Next: Bug Lists,  Up: Bugs
  620. Have You Found a Bug?
  621. =====================
  622.    If you are not sure whether you have found a bug, here are some
  623. guidelines:
  624.    * If the compiler gets a fatal signal, for any input whatever, that
  625.      is a compiler bug.  Reliable compilers never crash.
  626.    * If the compiler produces invalid assembly code, for any input
  627.      whatever (except an `asm' statement), that is a compiler bug,
  628.      unless the compiler reports errors (not just warnings) which would
  629.      ordinarily prevent the assembler from being run.
  630.    * If the compiler produces valid assembly code that does not
  631.      correctly execute the input source code, that is a compiler bug.
  632.      However, you must double-check to make sure, because you may have
  633.      run into an incompatibility between GNU C and traditional C (*note
  634.      Incompatibilities::.).  These incompatibilities might be considered
  635.      bugs, but they are inescapable consequences of valuable features.
  636.      Or you may have a program whose behavior is undefined, which
  637.      happened by chance to give the desired results with another C or
  638.      C++ compiler.
  639.      For example, in many nonoptimizing compilers, you can write `x;'
  640.      at the end of a function instead of `return x;', with the same
  641.      results.  But the value of the function is undefined if `return'
  642.      is omitted; it is not a bug when GNU CC produces different results.
  643.      Problems often result from expressions with two increment
  644.      operators, as in `f (*p++, *p++)'.  Your previous compiler might
  645.      have interpreted that expression the way you intended; GNU CC might
  646.      interpret it another way.  Neither compiler is wrong.  The bug is
  647.      in your code.
  648.      After you have localized the error to a single source line, it
  649.      should be easy to check for these things.  If your program is
  650.      correct and well defined, you have found a compiler bug.
  651.    * If the compiler produces an error message for valid input, that is
  652.      a compiler bug.
  653.    * If the compiler does not produce an error message for invalid
  654.      input, that is a compiler bug.  However, you should note that your
  655.      idea of "invalid input" might be my idea of "an extension" or
  656.      "support for traditional practice".
  657.    * If you are an experienced user of C or C++ compilers, your
  658.      suggestions for improvement of GNU CC or GNU C++ are welcome in
  659.      any case.
  660. File: gcc.info,  Node: Bug Lists,  Next: Bug Reporting,  Prev: Bug Criteria,  Up: Bugs
  661. Where to Report Bugs
  662. ====================
  663.    Send bug reports for GNU C to one of these addresses:
  664.      bug-gcc@prep.ai.mit.edu
  665.      {ucbvax|mit-eddie|uunet}!prep.ai.mit.edu!bug-gcc
  666.    Send bug reports for GNU C++ to one of these addresses:
  667.      bug-g++@prep.ai.mit.edu
  668.      {ucbvax|mit-eddie|uunet}!prep.ai.mit.edu!bug-g++
  669.    If your bug involves the C++ class library libg++, send mail to
  670. `bug-lib-g++@prep.ai.mit.edu'.  If you're not sure, you can send the
  671. bug report to both lists.
  672.    *Do not send bug reports to the mailing list `help-gcc', or to the
  673. newsgroup `gnu.gcc.help'.* Most users of GNU CC do not want to receive
  674. bug reports.  Those that do, have asked to be on `bug-gcc' and/or
  675. `bug-g++'.
  676.    The mailing lists `bug-gcc' and `bug-g++' both have newsgroups which
  677. serve as repeaters: `gnu.gcc.bug' and `gnu.g++.bug'.  Each mailing list
  678. and its newsgroup carry exactly the same messages.
  679.    Often people think of posting bug reports to the newsgroup instead of
  680. mailing them.  This appears to work, but it has one problem which can be
  681. crucial: a newsgroup posting does not contain a mail path back to the
  682. sender.  Thus, if maintainers need more information, they may be unable
  683. to reach you.  For this reason, you should always send bug reports by
  684. mail to the proper mailing list.
  685.    As a last resort, send bug reports on paper to:
  686.      GNU Compiler Bugs
  687.      Free Software Foundation
  688.      675 Mass Ave
  689.      Cambridge, MA 02139
  690.